3 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4 # ShellWiki is configured via Environment variables. The environment should
5 # usually be set in you webserver configuration.
6 # While this file explains possible environment setting its syntax is that of
7 # a shell script, and is likely different from the configuration file format
8 # used by your webserver.
9 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 # General `cgilite` settings
12 # ==========================
14 # The directory containing the ShellWiki installation.
16 # _EXEC=/opt/shellwiki
18 # If unset, shellwiki's `index.cgi` will try to determine this path from its
19 # argv[0] parameter. Since this is unreliable, you should set it correctly.
21 # The directory containing site data.
25 # Each site served by the installation must have its own data directory.
26 # If unset it will default to the working directory at startup, which is
27 # likely your www root. I strongly recommend to set this path to somewhere
28 # outside your www root.
30 # The local part of the URL from which Shellwiki is served.
34 # It is possible to serve Shellwiki on a subpage of you domain, e.g.
35 # http://example.com/apps/wiki where "/apps/wiki" would be the base directory.
36 # I recommend against doing this as it will be confusing when setting links
37 # within the wiki. If unsure leave empty!
39 # Dump the environment to stderr at script startup
43 # Leave empty if unsure.
45 # User authetication and registration
46 # -----------------------------------
47 # The following settings are used by the "default" auth module which is
48 # provided by `cgilite`. Settings may vary when using other authenticators.
54 # The default setting will find `sendmail` within your shells standard
55 # execution PATH. However, some systems may put sendmail into
56 # `/usr/lib/sendmail` or require you to set up your own mail wrapper
59 # Allow user registration
61 # USER_REGISTRATION=true
63 # Note that the first user will always be able to register, regardless of
66 # Require users to enter and confirm an email address when registering
68 # USER_REQUIREEMAIL=true
70 # Landing page after succesful registration
74 # It's safe to leave this empty.
76 # Expire user accounts after this much inactivity
78 # USER_ACCOUNTEXPIRE=$((86400 * 730))
80 # Value must be given in seconds and cannot be omitted. The default is
81 # ~ two years. Set this to a very high value, if you don't want accounts to
82 # expire unexpectedly.
84 # Expire unanswered user confirmations
86 # USER_CONFIRMEXPIRE=86400
88 # Value must be given in seconds. This value also sets the validity of
89 # invitation links. The default is 24 hours. It is not recommended to set
90 # this to more than a week.
92 # Sender address of registration emails
94 # MAILFROM=noreply@http_host
96 # If unset shellwiki will try to detrmine the domain part of the mail
97 # automatically using the HTTP Host header field. It is much safer to set
98 # this variable manually.
102 # user_db=$_DATA/users.db
104 # Unless you want to share a user database with other cgilite apps you
105 # should leave this as it is.
108 # General Wiki Settings
109 # =====================
111 # Enable page revisioning
115 # Only valid if `git` is available.
117 # Whether to enable revisioning of attachments
119 # REV_ATTACHMENTS=false
121 # Off by default. Requires page rvisioning to be enabled.
123 # Presentation theme of the wiki
127 # Themes can be found in the "themes/" folder. However most stying does not
128 # require to change the wiki theme.
130 # Enable page index and search
134 # Enables auto indexing of pages, which is requred for using the "/[search]"
135 # page and <<wikiform search>> macro. On by default.
137 # Authentication Plugin
141 # Authenticators can be found in the "auth/" folder.
143 # Enable multi language functionality
147 # This should be set to a key for your default language. Values are arbitrary
148 # but ISO-639 two letter codes are recommended to use the translated system
149 # pages of the default installation. E.g.: en, de, fr, it, ...
150 # If this option is enabled, page names starting with a colon (":") will
151 # obtain a special meaning as translations of their parent pages.
157 # A title string added to the <html><head><title> attribute for each page.
163 # Page cache expiry in seconds. ShellWiki will avoid rerendering a page within
164 # this time frame. Long cache retention may decrease overall server load and
165 # response times, but page macros like <<pagelist>> or <<include>> may not
166 # display current data. It is recommended to set this to a low value (e.g. 10
167 # seconds) rather than disabling it alltogether.
169 # Allow plain HTML code in markdown syntax
173 # While the original markdown specification allows plain HTML code to occur
174 # in markdown documents, it is strongly recommended to leave this disabled
175 # for security reasons. Enable it only if access in your wiki is restricted
176 # and all authors are fully trustworthy.
178 # Access Control Settings
179 # -----------------------
185 # ACLs that will be processed _before_ processing any page ACLs. Use this
186 # to grant universal access to a page adminitrator.
187 # The string may contain line breaks to permit multiple ACL lines.
189 # Set default ACLs (Note the line break!)
191 # ACL_DEFAULT="Known:read,write
194 # ACLs that will be processed _after_ processing any page ACLs. By default,
195 # unless overridde by page ACLs or ACL_OVERRIDE, all registered users can
196 # edit a page, and all anonymous users can only read.
197 # This does not prevent a page author from e.g. granting write access to
198 # outsiders since page ACLs take precedence over this setting.
203 # Authentication: moinmoin
205 # MOIN_USERS="${MOIN_USERS:-/srv/moinwiki/data/user/}"
207 # Location of the moinmoin "user/"-directory where all the user files
210 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211 # If you have choosen to ignore the initial recommendation of setting the
212 # environment in your webserver configuration, and if you have used this
213 # shellscript as a configuration template instead, you should, as a final
214 # step, source the `index.sh` file. This way the configuration script will
215 # serve as a wrapper and should be set as the page handler / scritp alias.
217 # Or you may omit the final line and simple source this config script before
218 # starting the cgi application.
219 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 # . "$_EXEC/index.sh"